Update README#805
Conversation
jayantsing-db
requested review from
gopalldb,
jprakash-db,
samikshya-db and
vikrantpuppala
jayantsing-db
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
jayantsing-db
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
There was a problem hiding this comment.
even OAuthDiscoveryURL is optional here
There was a problem hiding this comment.
should we add all auth methods here or just the top ones and reserve the uncommon ones like jwt, oauth refresh etc for the documentation page?
imo, this README is more developer facing than customer facing so we should write it so..
There was a problem hiding this comment.
Adding to this, let's try to minimize duplication between the readme and official documentation and also add a link to the official documentation in this readme
There was a problem hiding this comment.
We don't mention these in our public documentation.
There was a problem hiding this comment.
this in azure MSI doesn't make sense
There was a problem hiding this comment.
removed azure MSI as per https://github.com/databricks/databricks-jdbc/pull/805/files?w=1#r2059998155
There was a problem hiding this comment.
I think we should add our public documentation link here for more details.
There was a problem hiding this comment.
We can add public documentation link for config properties if one wants to go into more details on Auth
There was a problem hiding this comment.
It seems that our public documentation doesn't include all authentication types, and we also plan to exclude them from the README. Therefore, I believe this comment is now unnecessary.
There was a problem hiding this comment.
We can also add JVM property for nio under using the driver section
--add-opens=java.base/java.nio=org.apache.arrow.memory.core ALL-UNNAMED
There was a problem hiding this comment.
Let's not add this here. We can link to public documentation page for more Auth configuration options.
There was a problem hiding this comment.
I believe we don't mention JWT in our public documentation. Do you still want me to remove this from README? [Removing for now]
There was a problem hiding this comment.
This one as well. These are advanced OAuth options.
There was a problem hiding this comment.
I believe we don't mention OAuth with Refresh Token in our public documentation. Do you still want me to remove this from README? [Removing for now]
|
Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. |
jayantsing-db
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
jayantsing-db
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
There was a problem hiding this comment.
will this cover running fake service tests also?
There was a problem hiding this comment.
For fake service tests, I have added a separate detailed page in docs folder
There was a problem hiding this comment.
is this covered anywhere? else we can still keep the running part and move full documentation to a confluence page
There was a problem hiding this comment.
There is a separate page for integration test in docs folder
3 participants
Description
This pull request updates the README of the repository. The documentation for integration tests and logging has been relocated to separate files:
Testing
Additional Notes to the Reviewer